/* Copyright (c) 2010 OFXKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <Foundation/Foundation.h>
#import "OFXCurrency.h"
#import "OFXObject.h"

@interface OFXBalance : OFXObject {
  OFXCurrency* currency;
  NSDate* validAsOf;
  NSNumber* value;
  NSString* balanceType;
  NSString* balanceDescription;
  NSString* name;
}

/**
 * @property currency
 * @brief Currency this balance is reported in.
 */
@property(retain) OFXCurrency* currency;

/**
 * @property validAsOf
 * @brief Date the reported balance is valid of.
 */
@property(retain) NSDate* validAsOf;

/**
 * @property value
 * @brief Balance
 */
@property(retain) NSNumber* value;

/**
 * @property balanceType
 * @brief Balance type. 
 *
 * Possible values:
 * - DOLLAR = dollar (value formatted DDDD.cc) 
 * - PERCENT = percentage (value formatted XXXX.YYYY) 
 * - NUMBER = number (value formatted as is)
 */
@property(retain) NSString* balanceType;

/**
 * @property balanceDescription
 * @brief Balance description, A-80
 */
@property(retain) NSString* balanceDescription;

/**
 * @property name
 * @brief Balance name, A-32
 */
@property(retain) NSString* name;

@end
